perm filename HELOG.KRD[UP,DOC] blob sn#013201 filedate 1972-11-18 generic text, type T, neo UTF8
00100			HAND - EYE LOG PROGRAM DOCUMENTATION
00200	
00300							Randy Davis
00400							17 November 1972
00500	
00600	
00700	       HELOG   is   intended    to    maintain    a    log    (called
00800	HESLOG[SYS,HE])keeping  track  of  all  changes,  problems  with,  or
00900	additions to the system hardware and software.   Incanting R HELOG to
01000	the  monitor starts things off, and the program prints out the number
01100	of the most recent entry.  This will let you know  if  something  has
01200	been added since the last time you looked.
01300		You are then faced with the  first  big  choice  --  you  may
01400	choose  to  read  the  log,  write an entry into it, receive a set of
01500	instructions (a shortened version of this), or send a message to  all
01600	members  of  the hand-eye group.  Answers to program questions may be
01700	abbreviated to one letter, lower and upper case used interchangably.
01900	
02000	
02100	Writing
02200	-------
02300	
02400	entry Type = Trouble, Repair, Change, New, Warning,
02500	             also the combinations TR and RC.
02600	
02700	HW,SW or ? = Hardware,Software, or
02800		     '?' if you're not sure.
02900	
03000	Device     = Arm, Cohu camera, Sierra camera, or 
03100	             Library [of programs on SYS,HE]
03200	
03300	
03400	
03500	       If  the  entry  type is given as R, the program will print out
03600	all log entries made in the last two  weeks  categorized  as  Trouble
03700	reports  for  the  same  HW/SW  and  Device choices. You are asked to
03800	supply the entry number of the trouble report to  which  your  repair
03900	refers. Type a <cr> if there is none.
04000		When a repair entry does refer to a specific  trouble  entry,
04100	they  are  both  effectively 'cancelled' in the updated log by having
04200	their type category entered as 'X'.
04300		The  log entry may then be Typed at the terminal, or the name
04400	of a File supplied.  The file (SOS or TV) will be copied into the log
04500	as  is.  Avoid  using  π's  in column 1 of text as this will slow the
04600	program down in subsequent searches.
04700		The  program  times,  dates,  and signs the log automatically
04800	(except if you are signed in as SYS HE, in which  case  it  asks  for
04900	your real P,PN. Be sure to include the comma when typing it in.)
05000		Entries categorized as  "Warning"  types  also  result  in  a
05100	message being sent to all members of the hand-eye group advising them
05200	of the new entry.
     

00100	Reading
00200	-------
00300		The program types out the category types as column headers, as:
00400	#(s)	Date	Type	HW/SW	Device	* to spool
00500	
00600	       Entries  may be referenced by number, date, type, HW/SW/?, and
00700	device.   Each category should be separated from the next by a <tab>.
00800	A  *  in the proper column will spool the entries rather than sending
00900	them to the terminal.
01000	
01100	<number>  := <digit>  | <digit> : <digit>  |  <tab> 
01200	
01300	<type>    := T  |  R  |  C  |  N  |  TR  |  RC  |  X  |  W  |  <tab>
01400	
01500	<HWSW>    := H  |  S  |  ?  |  <tab>
01600	
01700	<device>  := A  |  C  |  S  |  L  |  <tab>
01800	
01900	<date>    := <day> <month>  |
02000		     <day> <month> <year>  |
02100		     <month> <day> , <year>  |
02200		     <month> <year>  |  <tab>
02300	
02400	       Entries  may  be  searched  under any single or combination of
02500	categories.   Combinations will produce all entries which satisfy all
02600	non-<tab> responses.
02700	
02800	Examples:
02900	
03000	8:14 <cr>  					prints entries 8-14
03100	
03200	<tab> 1 NOV <cr>				all entries since 1 NOV
03300	
03400	<tab> 1 NOV <tab> T <cr>			all trouble entries since
03500								1 NOV
03600	
03700	8:999<tab> <tab> C <tab> <tab> C <tab> * <cr>	spools all entries since
03800							the 8th that referred
03900							to changes in the Cohu
04000	                                                camera
04100	
04200	<tab> 1 NOV <tab> X <tab> H <tab> A <cr>	prints corresponding trouble
04300							and repair reports for the
04400							arm hardware since 1 NOV.
04500							Useful if you have a problem
04600							you think may have been 
04700							solved before.
04800	Messages
04900	--------
05000	       Messages may be sent to the hand-eye group (internally defined
05100	in  the  program  --  see Randy Davis to be included).  As in writing
05200	entries the text may either be typed or  a  file  name  supplied.  To
05300	encourage  brevity,  an  absolute limit of 20 lines exists. Keep them
05400	closer to 1 or 2.